Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bluetooth documentation #79

Merged
merged 8 commits into from
Oct 13, 2024
Merged

Conversation

Lewiscowles1986
Copy link
Contributor

just a stub page based on discord. Tested on my remarkable paper pro, it worked, I liked it.

Copy link
Contributor

@Eeems Eeems left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will need to specify that this is only for the reMarkable Paper Pro. It should also link to external documentation for the kernel module and bluetoothctl so that users can continue to red up on it there.

src/devel/device/bluetooth.rst Outdated Show resolved Hide resolved
src/devel/device/bluetooth.rst Outdated Show resolved Hide resolved
src/devel/device/bluetooth.rst Outdated Show resolved Hide resolved
src/devel/device/bluetooth.rst Outdated Show resolved Hide resolved
Co-authored-by: Nathaniel van Diepen <[email protected]>
@Eeems
Copy link
Contributor

Eeems commented Oct 8, 2024

For the external links you can throw at the bottom for users to get more information, the bluetooth archwiki article would probably be good. Here is what I can find on the kernel module: https://community.nxp.com/t5/i-MX-Processors-Knowledge-Base/Bluetooth-NXP-UART-Driver-Linux-BSP-6-1-22-btnxpuart/ta-p/1708588

@Lewiscowles1986
Copy link
Contributor Author

For the external links you can throw at the bottom for users to get more information, the bluetooth archwiki article would probably be good. Here is what I can find on the kernel module: https://community.nxp.com/t5/i-MX-Processors-Knowledge-Base/Bluetooth-NXP-UART-Driver-Linux-BSP-6-1-22-btnxpuart/ta-p/1708588

Can you tell me a little more about what you try to strive for with links. I can blindly copy-pasta the examples you gave, but I think we both want this to be useful, so understanding what you think works might help me address the needs better.

@Eeems
Copy link
Contributor

Eeems commented Oct 10, 2024

Can you tell me a little more about what you try to strive for with links. I can blindly copy-pasta the examples you gave, but I think we both want this to be useful, so understanding what you think works might help me address the needs better.

https://remarkable.guide/devel/device/upgrade_engine.html#external-links would be an example of what I'm looking for. It directs users to places with further reading to things that apply to what has been discussed in the article, with a short description that provides some context as to why it's relevant. This can be external tools that the reader could find useful, external documentation for something that would be a good reference, external documentation for something unrelated to rM that would have concepts that would be useful here, etc.

* also adjusts copy as requested by eems
* experimentally adds connecting a device with warning
@Lewiscowles1986
Copy link
Contributor Author

Changes made, both discussed and something I hope will make the page less of a stub.

src/devel/device/bluetooth.rst Outdated Show resolved Hide resolved
src/devel/device/bluetooth.rst Outdated Show resolved Hide resolved
src/devel/device/bluetooth.rst Outdated Show resolved Hide resolved
src/devel/device/bluetooth.rst Outdated Show resolved Hide resolved
Co-authored-by: Nathaniel van Diepen <[email protected]>
@Eeems Eeems changed the title docs: how to load module for bluetooth Add bluetooth documentation Oct 13, 2024
@Eeems Eeems merged commit 374f24a into Eeems-Org:main Oct 13, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants